<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rgb2ycrcb: rgb2ycrcb_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">rgb2ycrcb
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('rgb2ycrcb__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">rgb2ycrcb_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file demonstrates how to use Xilinx RGB to YCrCb Color Space Converter (RGB2YCRCB) driver on Xilinx RGB to YCrCb Color Space Converter (RGB2YCRCB) core. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
<hr/>

7.00 adk   07/07/14 First release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aeef4ba4c95a1b59618b52c190514217e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rgb2ycrcb__example_8c.html#aeef4ba4c95a1b59618b52c190514217e">XRGB_DEVICE_ID</a>&#160;&#160;&#160;XPAR_RGB2YCRCB_0_DEVICE_ID</td></tr>
<tr class="memdesc:aeef4ba4c95a1b59618b52c190514217e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following constants map to the XPAR parameters created in the xparameters.h file.  <a href="#aeef4ba4c95a1b59618b52c190514217e">More...</a><br /></td></tr>
<tr class="separator:aeef4ba4c95a1b59618b52c190514217e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9d1f933bc363b4c194f31f0a16f6c523"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rgb2ycrcb__example_8c.html#a9d1f933bc363b4c194f31f0a16f6c523">Rgb2YCrCb_Update_Example</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a9d1f933bc363b4c194f31f0a16f6c523"><td class="mdescLeft">&#160;</td><td class="mdescRight">RGB to YCrCb Color Space Converter Register Update Example.  <a href="#a9d1f933bc363b4c194f31f0a16f6c523">More...</a><br /></td></tr>
<tr class="separator:a9d1f933bc363b4c194f31f0a16f6c523"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rgb2ycrcb__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the Rgb2YCrCb example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br /></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a82f5b4955af88aafc455c2d5251cdfb9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rgb2ycrcb__example_8c.html#a82f5b4955af88aafc455c2d5251cdfb9">XRgbInstance</a></td></tr>
<tr class="memdesc:a82f5b4955af88aafc455c2d5251cdfb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instance of the RGB2YCRCB core.  <a href="#a82f5b4955af88aafc455c2d5251cdfb9">More...</a><br /></td></tr>
<tr class="separator:a82f5b4955af88aafc455c2d5251cdfb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aeef4ba4c95a1b59618b52c190514217e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeef4ba4c95a1b59618b52c190514217e">&#9670;&nbsp;</a></span>XRGB_DEVICE_ID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XRGB_DEVICE_ID&#160;&#160;&#160;XPAR_RGB2YCRCB_0_DEVICE_ID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The following constants map to the XPAR parameters created in the xparameters.h file. </p>
<p>They are defined here such that a user can easily change all the needed parameters in one place. </p>

<p class="reference">Referenced by <a class="el" href="rgb2ycrcb__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a840291bc02cba5474a4cb46a9b9566fe">&#9670;&nbsp;</a></span>main()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the Rgb2YCrCb example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful,</li>
<li>XST_FAILURE if it is unsuccessful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="rgb2ycrcb__example_8c.html#a9d1f933bc363b4c194f31f0a16f6c523">Rgb2YCrCb_Update_Example()</a>, and <a class="el" href="rgb2ycrcb__example_8c.html#aeef4ba4c95a1b59618b52c190514217e">XRGB_DEVICE_ID</a>.</p>

</div>
</div>
<a id="a9d1f933bc363b4c194f31f0a16f6c523"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d1f933bc363b4c194f31f0a16f6c523">&#9670;&nbsp;</a></span>Rgb2YCrCb_Update_Example()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Rgb2YCrCb_Update_Example </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>RGB to YCrCb Color Space Converter Register Update Example. </p>
<p>This function provides an example of the process used to update the coefficient and offset registers in the RGB2YCrCb core. .</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device id of the RGB2YCRCB core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful,</li>
<li>XST_FAILURE if it is un-successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html#ad683847c19dbf599798083ff18cbb641">XRgb2YCrCb_Coef_Inputs::ACoef</a>, <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html#a862675295a25a253dd20e2bb6a9c48b6">XRgb2YCrCb_Coef_Inputs::BCoef</a>, <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html#a72546aa6892d93c968aceec29d0f6459">XRgb2YCrCb_Coef_Inputs::CCoef</a>, <a class="el" href="struct_x_rgb2_y_cr_cb___coef___inputs.html#a53c098d2a630c468bea028aeab168287">XRgb2YCrCb_Coef_Inputs::DCoef</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga584a818bca95b80de513294519c54ee2">XRgb2YCrCb_CfgInitialize()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga548d29660d89f7e169bfec07d38a690e">XRgb2YCrCb_Coefficient_Translation()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gaca68d500975fddc7bf07026b51bfad15">XRgb2YCrCb_Enable</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga8267423a2342650df224b86fe8c423cd">XRgb2YCrCb_LookupConfig()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga8318672442e87588e708be47af32147c">XRgb2YCrCb_RegUpdateDisable</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga46c99c4878256389dcee6a88fe044c99">XRgb2YCrCb_RegUpdateEnable</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gad6a59676f9a37cb776215e22449f89ea">XRgb2YCrCb_Select_OutputRange()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga055a02edae1cc77605e360b675c56d80">XRgb2YCrCb_Select_Standard()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga068788cac52a17d49848da6443235ea1">XRgb2YCrCb_SetActiveSize()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gaa8918c65e3bd52acd1d0923a16a255eb">XRgb2YCrCb_SetCbMax()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gaaf72e639f6ec9a424f316360852fbe61">XRgb2YCrCb_SetCbMin()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga216aa5281d270baf69de79daf425a465">XRgb2YCrCb_SetCbOffset()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga2bb93dbcbf42c736cdcf61e9c75c93ce">XRgb2YCrCb_SetCoefs()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga09cb057bdb4c96b8a3d1ed2411fba8ff">XRgb2YCrCb_SetCrMax()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga7097a7fffb31f244f3d8b8980a41d7ed">XRgb2YCrCb_SetCrMin()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga3a4c66f6336a4ee35d36d0f95941f3af">XRgb2YCrCb_SetCrOffset()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gafd685f798f6c43ce121eec09d3f5fe7f">XRgb2YCrCb_SetYMax()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga8cfcf42b1428ad80a23abd74c8d4ca6b">XRgb2YCrCb_SetYMin()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gab4c03e136fcf6039a16ac5e6a2422921">XRgb2YCrCb_SetYOffset()</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#ga1048dbcafb7de9cc86cfea27492ea112">XRGB_DATA_WIDTH_8</a>, <a class="el" href="group__rgb2ycrcb__v7__0.html#gga0af3ea67f07c56f3bf624202c229595baf46fc4783402e68af1a74c8fbbf0d216">XRGB_STANDARD_ITU_601_SD</a>, and <a class="el" href="group__rgb2ycrcb__v7__0.html#gga9fced2690ef18942e406ab9145f75de1a6f69c367c43ecbb235c8ac3bc7e6fca4">XRGB_TV_16_TO_240</a>.</p>

<p class="reference">Referenced by <a class="el" href="rgb2ycrcb__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a82f5b4955af88aafc455c2d5251cdfb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82f5b4955af88aafc455c2d5251cdfb9">&#9670;&nbsp;</a></span>XRgbInstance</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_rgb2_y_cr_cb.html">XRgb2YCrCb</a> XRgbInstance</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Instance of the RGB2YCRCB core. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
